Dynatrace

Overview

Dynatrace is a leading application performance management (APM) tool that provides deep insights into the health and status of system components and instances across your IT environment.

By integrating Dynatrace with Enov8, you can automatically push health information from Dynatrace to Enov8 in real-time. This integration ensures that Enov8 is continually updated with the latest health status of your system components or instances, enabling proactive management and quicker response to potential issues. The result is a more resilient and well-monitored environment, reducing the risk of downtime and ensuring optimal performance.

Prerequisites

Before integrating Dynatrace with the Enov8 platform, ensure the following prerequisites are met:

Dynatrace Access and Permissions

• Ensure you have administrative access to your Dynatrace instance to create and manage integrations.
• Verify that your Dynatrace instance is accessible via the internet or the necessary network configurations are in place for communication with Enov8.

Enov8 Access and Permissions

• Ensure you have the necessary permissions within Enov8 to configure integrations in the Orchestration Management Module and access to the Add-On section.

Enov8 REST API Authentication

• Obtain the Enov8 REST API User ID & Key required for configuring the webhook listener to update Enov8. Ensure these credentials have the appropriate read, create and update permissions.

note

To obtain the REST API authentication details for Enov8, please refer to the Generating an API Key section.

Integration Steps

Add Dynatrace Webhook Listener

The first step in this integration is to add the Dynatrace Webhook Listener in Enov8, which will listen for incoming messages from Dynatrace.

To add, navigate to Orchestration Management >> Administration >> AddOns.

Click on "+ Add to library" on the Dynatrace Listener Panel.

Provide a user friendly name for your listener and click "Save". This will add the webhook listener to Orchestration Manager Script Listing.

Generate Webhook URL

Now navigate to Orchestration Management >> Scripts >> Manage Scripts. In this section, you will see a list of all the scripts that have been configured in ecosystem. Locate the webhook listener script added by you in the previous step and make a note of the Script ID.

Replace the Script ID in the URL below with the above Script ID Value to form the webook URL for Dynatrace.

{vo url}/client/scripts/{Script ID}/index.php

Provide this URL to your Dynatrace Administrator to setup a webhook in Dynatrace to trigger based on your required event. Common events include when your environment instance or component goes up or down.

info

To successfully integrate Dynatrace with Enov8, you'll need to set up problem notifications via webhooks in Dynatrace. If you're unfamiliar with how to create and configure notifications, please refer to the official Dynatrace documentation for detailed instructions:

• Dynatrace Notifications via webhooks

This guide provides step-by-step instructions on how to configure webhook in Dynatrace to push problem notifications, ensuring that you can effectively send data to the Enov8 platform.

Configure Webhook Listener Mapping

The next step in the integration is to configure the mapping in the webhook listener. To edit the mapping, click on the explorer icon in the listing.

Select config.json in the file dropdown. This will open the config in the file editor.

The first step in configuring the mapping is to provide enov8 platform REST API Authenication details in the below section of the config.

API Section

  "api_details": {
                        "app_id":"EXAMPLE_APP_ID",
                        "app_key":"EXAMPLE_APP_KEY",
                        "user_id":"EXAMPLE_USER_ID",
                        "enov8_url":"http://EXAMPLE_HOST/ecosystem/",
                        "default_org":"ORG_ECO_ID"
                }  

The next step in configuring the mapping of the payload which will be recieved from JIRA to enov8 class properties.

Dynatrace Ecosystem Field Mapping Section

The below example provides a sample mapping to map Dynatrace Payload to ecosystem System Component Class properties. On receiving the payload from Dynatrace, it will automatically update the status of relevant system component in enov8 platform.

 "Dynatrace": {
                "unique_id": "Resource Name",
                "class": "SystemComponent",
                "mapping": [
                        {
                                "ecosys": "Resource Name",
                                "source": "affectedEntities.[].name",
                                "mandatory": true,
                                "default_value": null,
                                "workflow": null
                        },
                        {
                                "ecosys": "Status",
                                "source": "status",
                                "mandatory": true,
                                "default_value": null,
                                "workflow": "OPEN:UnplannedOutage|CLOSED:InOperation"
                        }
                ]
        }